Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(string): improve documentation for length parameters #3216

Merged
merged 6 commits into from
Nov 3, 2024
Merged

docs(string): improve documentation for length parameters #3216

merged 6 commits into from
Nov 3, 2024

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Oct 22, 2024 •
edited
Loading

Fixes #2695 (comment)

The rest of the issue will be fixed in a separate PR.

Improves and unifies the documentation of the length parameter in the string module.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent m: string Something is referring to the string module labels Oct 22, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Oct 22, 2024
@ST-DDT ST-DDT requested review from a team October 22, 2024 15:10
@ST-DDT ST-DDT self-assigned this Oct 22, 2024
@netlify Netlify
Copy link

netlify bot commented Oct 22, 2024 •
edited
Loading

✅ Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit bd96994
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/67275299ff01820009e9adb6
😎 Deploy Preview https://deploy-preview-3216.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Oct 22, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (c0a7e23) to head (bd96994).
Report is 1 commits behind head on next.

Additional details and impacted files 
@@            Coverage Diff             @@
##             next    #3216      +/-   ##
==========================================
+ Coverage   99.94%   99.96%   +0.01%     
==========================================
  Files        2805     2805              
  Lines      217098   217098              
  Branches      962      972      +10     
==========================================
+ Hits       216989   217021      +32     
+ Misses        109       77      -32
Files with missing lines Coverage Δ
src/modules/string/index.ts 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

@ST-DDT ST-DDT mentioned this pull request Oct 23, 2024
Open
10 tasks
xDivisionByZerox
xDivisionByZerox approved these changes Nov 2, 2024
View reviewed changes
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is great for documentation purposes, I don't see how this fixes #2695 fully.

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 2, 2024

It isnt meant to.
There is a second part to the issue, but I cannot tackle it without the first part.

@xDivisionByZerox
Copy link
Member

It isnt meant to.

I was nearly certain about this, but the current PR description said otherwise:

Fixes #2695 (comment)

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 2, 2024

I was nearly certain about this, but the current PR description said otherwise:

Fixes #2695 (comment)

The PR fixes the referenced comment, not the entire issue. I'll change the description to make it more obvious.

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 3, 2024

Merging earlier to include in release

@ST-DDT ST-DDT added this pull request to the merge queue Nov 3, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Nov 3, 2024
@ST-DDT ST-DDT enabled auto-merge (squash) November 3, 2024 10:38
@ST-DDT ST-DDT merged commit 18f14c8 into next Nov 3, 2024
21 checks passed
@ST-DDT ST-DDT deleted the docs/string/length branch November 3, 2024 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xDivisionByZerox xDivisionByZerox xDivisionByZerox approved these changes

Assignees

@ST-DDT ST-DDT

Labels
c: docs Improvements or additions to documentation m: string Something is referring to the string module p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging this pull request may close these issues.

Improve DX for methods that use all memory
2 participants
@ST-DDT @xDivisionByZerox